-
-
Notifications
You must be signed in to change notification settings - Fork 699
Docker compose migration #1692
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Docker compose migration #1692
Conversation
|
WalkthroughThe changes update documentation and script commands to reflect the shift from the deprecated Changes
Sequence Diagram(s)sequenceDiagram
participant U as User
participant S as System
U->>S: Create Docker config and CLI plugins directories
U->>S: Download Docker Compose binary to CLI plugins directory
U->>S: Update file permissions at new location
U->>S: Run verification with "docker compose" command
S-->>U: Return installation success info
Poem
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
🧹 Nitpick comments (3)
DOCKER_INSTALLATION.md (3)
11-11
: Fix grammar: "setup" should be "set up".The word "setup" is a noun, while "set up" is the correct verb form.
-First you need to setup docker compose as it is an underlying tool that this command: `pnpm run docker` fires behind the scene. +First you need to set up docker compose as it is an underlying tool that this command: `pnpm run docker` fires behind the scene.🧰 Tools
🪛 LanguageTool
[grammar] ~11-~11: The word “setup” is a noun. The verb is spelled with a space.
Context: ... you can avoid that. First you need to setup docker compose as it is an underlying t...(NOUN_VERB_CONFUSION)
54-56
: Add language specifier to the code block.For consistency and proper syntax highlighting, specify the language for the code block.
- ``` + ```shell Docker Compose version vX.Y.Z ```🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
54-54: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
60-60
: Add comma before "and" in compound sentence.For better readability, add a comma before "and" as it connects two independent clauses.
-When you've verified that the `docker compose` package is installed and you proceed to start Docker with `pnpm run docker`. +When you've verified that the `docker compose` package is installed, and you proceed to start Docker with `pnpm run docker`.🧰 Tools
🪛 LanguageTool
[uncategorized] ~60-~60: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...hedocker compose
package is installed and you proceed to start Docker with `pnpm ...(COMMA_COMPOUND_SENTENCE)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
DOCKER_INSTALLATION.md
(1 hunks)package.json
(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- package.json
🧰 Additional context used
🪛 LanguageTool
DOCKER_INSTALLATION.md
[grammar] ~11-~11: The word “setup” is a noun. The verb is spelled with a space.
Context: ... you can avoid that. First you need to setup docker compose as it is an underlying t...
(NOUN_VERB_CONFUSION)
[uncategorized] ~60-~60: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...he docker compose
package is installed and you proceed to start Docker with `pnpm ...
(COMMA_COMPOUND_SENTENCE)
🪛 markdownlint-cli2 (0.17.2)
DOCKER_INSTALLATION.md
54-54: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
🔇 Additional comments (1)
DOCKER_INSTALLATION.md (1)
1-136
: LGTM! The Docker Compose migration is well documented.The changes successfully update the installation instructions to use the new
docker compose
command, providing clear and comprehensive guidance for all supported platforms.🧰 Tools
🪛 LanguageTool
[grammar] ~11-~11: The word “setup” is a noun. The verb is spelled with a space.
Context: ... you can avoid that. First you need to setup docker compose as it is an underlying t...(NOUN_VERB_CONFUSION)
[uncategorized] ~60-~60: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...hedocker compose
package is installed and you proceed to start Docker with `pnpm ...(COMMA_COMPOUND_SENTENCE)
🪛 markdownlint-cli2 (0.17.2)
3-3: Trailing punctuation in heading
Punctuation: '.'(MD026, no-trailing-punctuation)
54-54: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
DOCKER_INSTALLATION.md
Outdated
|
||
```shell | ||
sudo apt install curl | ||
curl -SL "https://github.com/docker/compose/releases/download/latest/docker-compose-$(uname -s)-$(uname -m)" -o $DOCKER_CONFIG/cli-plugins/docker-compose |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
💡 Verification agent
🧩 Analysis chain
Avoid using "latest" tag in the download URL.
Using "latest" in the download URL can lead to reproducibility issues as different users might get different versions. Consider specifying a fixed version number.
Let's check the latest stable version of Docker Compose:
🌐 Web query:
What is the latest stable version of Docker Compose?
💡 Result:
The latest stable version of Docker Compose is v2.32.4, released on January 16, 2025[1][3][4]. This update includes critical bug fixes such as resolving an issue where docker compose version
did not display properly[3][4].
Docker Compose V2 has been the default and actively maintained version since July 2023[1][5], replacing the deprecated V1 (last updated in May 2021)[1][6]. Key improvements in recent versions include:
- Enhanced build performance with BuildKit
- Support for service hooks and CDI device requests (v2.30.0)[3]
- Improved network configuration detection (v2.29.2)[3]
- Synchronized file shares for bind mounts (v2.26.0)[3]
For new installations, Docker Desktop automatically includes Compose V2[1][5]. Linux users can manually install it using:
docker compose version
which should return Docker Compose version v2.32.4
[3][4].
Citations:
- 1: https://docs.docker.com/compose/releases/migrate/
- 2: https://forums.docker.com/t/docker-compose-version-3-8-or-3-9-for-latest/102439
- 3: https://docs.docker.com/compose/releases/release-notes/
- 4: https://github.com/docker/compose/releases
- 5: https://docs.docker.com/compose/install/
- 6: https://docs.docker.com/compose/
- 7: https://dev.to/ajeetraina/do-we-still-use-version-in-compose-3inp
- 8: https://www.youtube.com/watch?v=bknPCJMyVMA
Update download URL to avoid using "latest" tag in favor of a fixed version.
The current line uses:
curl -SL "https://github.com/docker/compose/releases/download/latest/docker-compose-$(uname -s)-$(uname -m)" -o $DOCKER_CONFIG/cli-plugins/docker-compose
This approach can lead to reproducibility issues. Our web query confirms that the latest stable version of Docker Compose is v2.32.4. Consider updating the URL to specify this version number:
- Replace
latest
withv2.32.4
(or another fixed version) to ensure consistency across installations.
Hey @rharkor - thanks for this! We should really get this in. Would be good if this didn't break existing dev setups. Have you tested what happens to existing containers? Specifically:
I think I ran into issues with this previously. Would be great to know what happens before we get a chance to test the new instructions myself. Thanks again 🙏 |
Hey @nicktrn following the documentation it seems that you will need to stop every container before restarting theme because compose v1 use "_" and compose v2 use "-" as separator |
Ah perfect, that's what I was looking for! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
♻️ Duplicate comments (1)
DOCKER_INSTALLATION.md (1)
27-27
: Pin Docker Compose version for reproducible installs
To avoid pulling an unpredictable version, specify a fixed release (e.g.,v2.32.4
) instead of usinglatest
in the download URL.
🧹 Nitpick comments (3)
DOCKER_INSTALLATION.md (3)
11-11
: Correct verb usage: "set up" vs "setup"
The word “setup” is a noun; here you need the verb form “set up” when instructing the user.🧰 Tools
🪛 LanguageTool
[grammar] ~11-~11: The word “setup” is a noun. The verb is spelled with a space.
Context: ... you can avoid that. First you need to setup docker compose as it is an underlying t...(NOUN_VERB_CONFUSION)
55-57
: Specify the language for the output code block
The fenced code block showing the version output should declare a language (e.g.,text
orbash
) to satisfy markdown lint rules.
60-60
: Add comma for compound sentence clarity
Insert a comma before “and” to separate independent clauses:
“When you’ve verified that thedocker compose
package is installed, and you proceed to start Docker…”🧰 Tools
🪛 LanguageTool
[uncategorized] ~60-~60: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...hedocker compose
package is installed and you proceed to start Docker with `pnpm ...(COMMA_COMPOUND_SENTENCE)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
DOCKER_INSTALLATION.md
(1 hunks)
🧰 Additional context used
🪛 LanguageTool
DOCKER_INSTALLATION.md
[grammar] ~11-~11: The word “setup” is a noun. The verb is spelled with a space.
Context: ... you can avoid that. First you need to setup docker compose as it is an underlying t...
(NOUN_VERB_CONFUSION)
[uncategorized] ~60-~60: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...he docker compose
package is installed and you proceed to start Docker with `pnpm ...
(COMMA_COMPOUND_SENTENCE)
🪛 markdownlint-cli2 (0.17.2)
DOCKER_INSTALLATION.md
54-54: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I tested everything works and only made two small changes:
- Fixed the download URL for the
latest
release - Made the
electric
container name static (it's the only one that wasn't)
We don't use the dev compose so I haven't touched it.
Thanks again @rharkor!
✅ Checklist
Testing
pnpm run docker
/pnpm run docker:stop
Changelog
Replaced the old
docker-compose
version with the newdocker compose
command since the old one is deprecated, according to:💯
Summary by CodeRabbit
docker compose
syntax for managing services.